Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The campaign unique identifier

Query Parameters

customer_id
string

Filter coupon availability for a specific customer. Only applies to COUPONS campaigns.

includes
enum<string>

Whether to include additional data inside attributes Only applies to COUPONS campaigns. Adds attributes.codes_summary with used, total, left, codes, and codes_usage.

Available options:
CODES_SUMMARY

Response

Ok

data
object

Campaign response. account_id, order, and created_at are not returned.